API Documentation
DepthStencilState.h
1 // DepthStencilState.h
3 //
5 
6 namespace nkGraphics
7 {
11  class DLL_GRAPHICS_EXPORT DepthStencilState : public Resource, public nkExport::Exportable
12  {
13  public :
14 
22  virtual ~DepthStencilState () ;
23 
27  virtual bool getDepthEnabled () const = 0 ;
31  virtual DEPTH_WRITE_MASK getDepthMasking () const = 0 ;
35  virtual COMPARISON_FUNC getDepthComparison() const = 0 ;
36 
40  virtual bool getStencilEnabled () const = 0 ;
44  virtual unsigned char getStencilReadMask () const = 0 ;
48  virtual unsigned char getStencilWriteMask () const = 0 ;
52  virtual STENCIL_OP getStencilFailFrontFace () const = 0 ;
60  virtual STENCIL_OP getStencilDepthOkFrontFace () const = 0 ;
68  virtual STENCIL_OP getStencilFailBackFace () const = 0 ;
76  virtual STENCIL_OP getStencilDepthOkBackFace () const = 0 ;
81 
85  virtual void resetToDefault () = 0 ;
86 
92  virtual void setDepthEnabled (bool value) = 0 ;
98  virtual void setDepthMasking (DEPTH_WRITE_MASK value) = 0 ;
104  virtual void setDepthComparison (COMPARISON_FUNC value) = 0 ;
105 
111  virtual void setStencilEnabled (bool value) = 0 ;
117  virtual void setStencilReadMask (unsigned char value) = 0 ;
123  virtual void setStencilWriteMask (unsigned char value) = 0 ;
129  virtual void setStencilFailFrontFace (STENCIL_OP value) = 0 ;
135  virtual void setStencilOkDepthFailFrontFace (STENCIL_OP value) = 0 ;
141  virtual void setStencilDepthOkFrontFace (STENCIL_OP value) = 0 ;
153  virtual void setStencilFailBackFace (STENCIL_OP value) = 0 ;
159  virtual void setStencilOkDepthFailBackFace (STENCIL_OP value) = 0 ;
165  virtual void setStencilDepthOkBackFace (STENCIL_OP value) = 0 ;
172 
178  virtual void exportClassToTree (nkExport::Node* rootNode) ;
184  virtual void importClassFromTree (nkExport::Node* rootNode) ;
185  } ;
186 }
nkGraphics::DepthStencilState::setStencilWriteMask
virtual void setStencilWriteMask(unsigned char value)=0
nkGraphics::DepthStencilState::getStencilFailFrontFace
virtual STENCIL_OP getStencilFailFrontFace() const =0
nkGraphics::DepthStencilState::resetToDefault
virtual void resetToDefault()=0
nkGraphics::DepthStencilState::getDepthComparison
virtual COMPARISON_FUNC getDepthComparison() const =0
nkGraphics::DepthStencilState::getStencilReadMask
virtual unsigned char getStencilReadMask() const =0
nkGraphics::DepthStencilState::setStencilOkDepthFailBackFace
virtual void setStencilOkDepthFailBackFace(STENCIL_OP value)=0
nkGraphics::DepthStencilState::getDepthMasking
virtual DEPTH_WRITE_MASK getDepthMasking() const =0
nkExport::Exportable
An interface to define objects that can be exported using this component.
Definition: Exportable.h:15
nkGraphics::DepthStencilState::exportClassToTree
virtual void exportClassToTree(nkExport::Node *rootNode)
nkGraphics::DepthStencilState::setStencilComparisonBackFace
virtual void setStencilComparisonBackFace(COMPARISON_FUNC value)=0
nkGraphics::DepthStencilState::setStencilDepthOkFrontFace
virtual void setStencilDepthOkFrontFace(STENCIL_OP value)=0
nkGraphics::DepthStencilState::setDepthEnabled
virtual void setDepthEnabled(bool value)=0
nkGraphics::DepthStencilState::getStencilFailBackFace
virtual STENCIL_OP getStencilFailBackFace() const =0
nkGraphics::DepthStencilState::setStencilComparisonFrontFace
virtual void setStencilComparisonFrontFace(COMPARISON_FUNC value)=0
nkGraphics::DepthStencilState::getStencilEnabled
virtual bool getStencilEnabled() const =0
nkGraphics::DepthStencilState::setStencilFailBackFace
virtual void setStencilFailBackFace(STENCIL_OP value)=0
nkGraphics::DEPTH_WRITE_MASK
DEPTH_WRITE_MASK
Available depth write masks.
Definition: DxDefinesWrapper.h:266
nkGraphics::DepthStencilState::setDepthComparison
virtual void setDepthComparison(COMPARISON_FUNC value)=0
nkGraphics::DepthStencilState::getStencilOkDepthFailBackFace
virtual STENCIL_OP getStencilOkDepthFailBackFace() const =0
nkGraphics::DepthStencilState::getDepthEnabled
virtual bool getDepthEnabled() const =0
nkGraphics::DepthStencilState::DepthStencilState
DepthStencilState()
nkExport::Node
A node in the tree structure representing the data to export / import.
Definition: Node.h:42
nkGraphics::DepthStencilState::setStencilFailFrontFace
virtual void setStencilFailFrontFace(STENCIL_OP value)=0
nkGraphics::DepthStencilState
Holds information about a depth and stencil state used for rendering.
Definition: DepthStencilState.h:12
nkGraphics::DepthStencilState::setStencilDepthOkBackFace
virtual void setStencilDepthOkBackFace(STENCIL_OP value)=0
nkGraphics::DepthStencilState::getStencilOkDepthFailFrontFace
virtual STENCIL_OP getStencilOkDepthFailFrontFace() const =0
nkGraphics::Resource
Base class for a resource in the component.
Definition: Resource.h:12
nkGraphics::DepthStencilState::getStencilDepthOkBackFace
virtual STENCIL_OP getStencilDepthOkBackFace() const =0
nkGraphics::DepthStencilState::setStencilReadMask
virtual void setStencilReadMask(unsigned char value)=0
nkGraphics::DepthStencilState::setStencilOkDepthFailFrontFace
virtual void setStencilOkDepthFailFrontFace(STENCIL_OP value)=0
nkGraphics::DepthStencilState::setDepthMasking
virtual void setDepthMasking(DEPTH_WRITE_MASK value)=0
nkGraphics::DepthStencilState::importClassFromTree
virtual void importClassFromTree(nkExport::Node *rootNode)
nkGraphics::COMPARISON_FUNC
COMPARISON_FUNC
Available comparison functions.
Definition: DxDefinesWrapper.h:139
nkGraphics::DepthStencilState::getStencilWriteMask
virtual unsigned char getStencilWriteMask() const =0
nkGraphics::STENCIL_OP
STENCIL_OP
Available stencil operations.
Definition: DxDefinesWrapper.h:276
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7
nkGraphics::DepthStencilState::getStencilDepthOkFrontFace
virtual STENCIL_OP getStencilDepthOkFrontFace() const =0
nkGraphics::DepthStencilState::~DepthStencilState
virtual ~DepthStencilState()
nkGraphics::DepthStencilState::setStencilEnabled
virtual void setStencilEnabled(bool value)=0
nkGraphics::DepthStencilState::getStencilComparisonBackFace
virtual COMPARISON_FUNC getStencilComparisonBackFace() const =0
nkGraphics::DepthStencilState::getStencilComparisonFrontFace
virtual COMPARISON_FUNC getStencilComparisonFrontFace() const =0